Audit references/module.md (#3): cross-links, four content gaps, J6.1 verification#13
Merged
Merged
Conversation
…erify Closes the module.md checklist in #3. Cross-references to shared refs (cross-cutting principle from #2): - Manifest XML section: cross-link intro pointing to manifest.md for universal elements; example keeps module-specific bits (client=, <config><fields name="params">). - New Language Files section: MOD_* prefix specifics + cross-link to language-files.md. - Service Provider section: cross-link intro pointing to service-provider.md for the universal wrapping pattern; example keeps module-specific factory triple (ModuleDispatcherFactory, HelperFactory, Module). - New Install Script (Optional) section: pointer to install-script.md with note that modules rarely need one. Content gaps closed (flagged by audit): - Web Asset Manager registration from the dispatcher: new subsection showing useStyle/useScript against joomla.asset.json-resolved URIs and where to register Text::script() keys, with cross-reference to gotchas.md for the URI-resolution and truthy-key rules. - Caching: new section explaining default per-instance keying, the two cases that need user attention (URL-dependent + session-state- dependent output), and the absence of a public dispatcher-level cache-key hook. Joomla 6.1 verification (continuous discipline from issue #11): - Dispatcher section cites AbstractModuleDispatcher on 6.1-dev for constructor + getLayoutData signatures. - Service Provider section cites mod_articles_news provider on 6.1-dev for the factory triple. - New Joomla 6.1 capabilities section covers PR #46772 (Versions for Modules / #__ucm_history) and PR #46622 (#__extensions.custom_data column). Both additive, no existing-code changes required. Table of Contents rebuilt to expose all new sections and flag which content lives in the shared references. CHANGELOG [Unreleased] gets new sections for the additions and verifications.
This was referenced Apr 30, 2026
bcordis
added a commit
that referenced
this pull request
Apr 30, 2026
…stency (#17) Surface the five shared references (manifest.md, install-script.md, language-files.md, service-provider.md, component-router.md) in SKILL.md's index — they were extracted in PRs #9/#13/#14/#15 and linked from per-type files but never indexed in SKILL.md itself. Add deferral pointers at the head of SKILL.md's Service Provider, Language Files, Manifest XML, and Install/Update Script sections so shared content has one canonical home and the inline component-flavored examples are explicitly framed as type-specific. Harmonize SKILL.md's install-script preflight example with the canonical Log::add(..., 'jerror') pattern in install-script.md; was using \$adapter->getParent()->abort(...) which is also valid but is the kind of "same situation, two patterns" drift issue #6 is meant to catch. Verified (no changes needed): per-extension service-provider / install-script / language-files sections in component.md, module.md, plugin.md, library.md all defer correctly to the shared references. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes the
module.mdchecklist in #3.Summary
The audit found
module.mdwas already current on the load-bearing patterns (dispatcher, helper, manifest, service provider) but had zero cross-references to the four shared references created during #2 (manifest.md,language-files.md,service-provider.md,install-script.md) and was missing four legitimate content topics. This PR adds the cross-links, fills the gaps, and verifies the dispatcher / service-provider patterns againstjoomla-cms6.1-dev.Cross-references to shared refs (the principle from #2)
manifest.mdfor universal elements; the example keeps module-specific bits (client="…",<config><fields name="params">).MOD_*prefix specifics + cross-link tolanguage-files.md.service-provider.mdfor the universal wrapping pattern; the example keeps the module-specificModuleDispatcherFactory/HelperFactory/Moduletriple.install-script.mdwith the note that modules rarely need one.Content gaps filled
useStyle/useScriptagainstjoomla.asset.json-resolved URIs and where to registerText::script()JS strings. Cross-referencesgotchas.mdfor URI auto-resolution and the truthy-key trap.J6.1 verification (continuous discipline from #11)
AbstractModuleDispatcheron6.1-dev— constructor($module, CMSApplicationInterface $app, Input $input)andgetLayoutData()returningarray|falsewithmodule/app/input/params/templatekeys both confirmed unchanged for 6.1.mod_articles_news/services/provider.phpon6.1-dev— confirms theModuleDispatcherFactory/HelperFactory/Moduletriple is still the current pattern for 6.1.#__ucm_history) and PR #46622 (#__extensions.custom_dataJSON column). Both are additive — no existing code changes required.Why these scope choices
module.md: the file is now 362 lines after additions, well below the threshold where extraction was warranted in Audit: references/component.md #2.CMSPlugin, so they're unaffected.Test plan
bash scripts/validate.shpasses.joomla-cms6.1-devsource.manifest.md/service-provider.md/language-files.md) when the question is universal.validate.ymlworkflow green.Generated by Claude Code